home *** CD-ROM | disk | FTP | other *** search
/ United Public Domain Gold 2 / United Public Domain Gold 2.iso / utilities / pu432.dms / pu432.adf / User Manual.doc < prev    next >
Text File  |  1992-09-02  |  21KB  |  459 lines

  1.                             (C) D.Odd Oct 1993
  2.  
  3. B L A C K B O A R D  V 1.0  --- Users Manual
  4. --------------------------
  5.  
  6. ABOUT THIS DOCUMENT
  7. -------------------
  8.  
  9.     This document is organised so that the further you go through it
  10. the less general the information becomes. Try to read through the first 
  11. few sections at least before you rush in, get frustrated, and have to come
  12. back and read it anyway. These bits deal with setting up, registration and
  13. general use.
  14.     The further on bits in the document are more reference-like for when
  15. you want to use a particular function.
  16.  
  17. IDEOLOGY
  18. --------
  19.  
  20.     I have a dream. Because of the way this program is written, it's 
  21. easy for anyone out there to write new modules and expand the system. In
  22. this way, if the program gets a wide enough user base - literaly hundreds
  23. of new functions could be written by other users. These could be produce a
  24. large library of functions in the public domain which would provide a
  25. constantly expanding and improving system.
  26.     In short it COULD provide, by pooling the resources of everyone out
  27. there, a system more powerfull, more flexible, more customisable and most
  28. importantly far CHEAPER than the expensive commercial options on offer. 
  29.  
  30. INTRODUCTION
  31. ------------
  32.  
  33.     BlackBoard is an image proccessor written specifically for the AGA
  34.  chip-set machines. The system requirements are 2 floppy drives (or a hard
  35.  drive), and at least a meg of memory. Idealy you should also have a bit
  36.  more memory and the AGA chip-set.
  37.  
  38. * The program is freely distributable. Providing this document is        *
  39. * distributed with it. If you don't like it please DELETE it and be done *
  40. * with it. If you DO like it and find it useful then please send me the  *
  41. * registration fee and you will become a legal registered user and will  *
  42. * get a whole load of goodies through the post (see the section entitled *
  43. * 'REGISTRATION')                                                        *
  44.  
  45.     The program is formed by a number of disk-based modules which are
  46.  run as required. This means that almost every aspect of the program can be
  47.  upgraded and improved without having to re-write the whole thing. It also
  48.  means that anyone can write their own add-on modules  (e.g. Loaders,
  49.  Displayers, filters etc.) providing they stick to certain guidelines
  50.  (see 'REGISTRATION')
  51.  
  52.     BlackBoard can load in pictures. It can manipulate them in a
  53.  variety of ways, and then it can display them in a number of different
  54.  display modes as well as saving the picture to disk. 
  55.  
  56. N.B I apologise for the speed at which you can load in IFF pictures. I`m
  57. currently working on an assembly-language written version to replace it -
  58. which will be supplied with REGISTRATION.   
  59.  
  60. SETTING UP
  61. ----------
  62.     
  63.     The first time you run BlackBoard you must select the type of chip 
  64. set you have. If you have any machine with the AGA chip set (e.g. A1200,
  65. A4000 or A5000) then run the file entitled '24bit_Amigas'. Otherwise
  66. run the program called '12bit_Amiga'.
  67.  
  68.     Each time before you run the program, the program INIT must be
  69.  executed. This can be done either through a startup-sequence or you can
  70.  just double-click on it's icon. This sets up a number of system variables.
  71.     When you run it it may ask you to insert 'BBoard:'. This is simply
  72.  checking if the 'volume' already exists. Simply click on CANCEL and the 
  73.  program will assign it to the RAM disk.
  74.     You can then run the main program - BLACKBOARD 
  75.  
  76. RUNNING IT
  77. ----------
  78.  
  79.     While using the program you must keep the disk 'BlackBoard:' in the
  80. drive at all times. This is because it contains all the functions and 
  81. filters and stuff which you can use. If you take it out the program can't 
  82. find what it wants (say the program which displays the picture) and so can't
  83. do what you want. To get round this there are two alternatives. Firstly
  84. if you have oodles of ram, you can move ALL the files onto the RAM: disk, 
  85. TAKE THE ORIGINAL DISK OUT, and enter the command (e.g. use Shell) 'Assign
  86. BlackBoard: RAM:'.
  87.      Secondly if you have a HARD DRIVE you can again move the files across,
  88. TAKE THE ORIGINAL DISK OUT, and enter the command 'Assign BlackBoard: DH0:'
  89.  
  90. REGISTRATION
  91. ------------
  92.  
  93.  If you like this program and use it AT ALL, please register with me. In
  94. return you will receive an updated copy of the program and modules, 
  95. but you will also get a load of goodies which I couldn`t fit on this 
  96. disk.  In brief you get...
  97.  
  98.     i) A disk FULL of additional stuff to help you get going.
  99.        The extra stuff includes...
  100.        -  A new display function which allows users with ALL
  101.           chip sets to display pictures in 128 shades. WOW!
  102.           (Wasn't fully de-bugged and so wasn't put on this disk)
  103.        -  New Modules to perform new functions including FLIP, ARC 
  104.        PALETTE, PIXELATE, INVERSE, QUANTISE
  105.        -  New loaders/savers for new formats (including the only (as far
  106.           as I'm aware) the only Archimedies format loader on the Amiga,
  107.           and a new faster Load_ILBM module)
  108.        -  New textures (e.g. rock, wood and more)
  109.        -  Half a dozen more dithers.
  110.  
  111.     ii) Information on how YOU can write your own functions and
  112.         stuff, with ANY programing language you like.
  113.         PLUS information about how to move the files about and use 
  114.         different ways of storing the data. e.g. Store the data on your
  115.         harddrive or carddrive instead of in memory. (Virtual Memory)
  116.         PLUS assistance with any problems that you may encounter with
  117.           any aspect of the program.
  118.         PLUS information on how to customize and optimize your system.
  119.          
  120.     iii)  New modules and updates on any bits of the program AS THEY
  121.           ARE WRITTEN. These will be posted to you or be released
  122.           in the PD market (they will only work on registered versions
  123.           of the program)    
  124.  
  125.     This stuff is what is available AT THE MOMENT (October '93). Any 
  126. additional stuff will be added to this list and supplied to registered 
  127. users.  
  128.      Features not finished YET, but which should be done soon are
  129.     JPEG file support, ARexx control, and a warping and morphing 
  130.     module.  
  131.     
  132.     And the price? 
  133.     Well 10 pounds sterling (or rough equivalent) that's all. However if 
  134.     you happen to be a student, unemployed or an OAP the price becomes 
  135.     slashed to a measly 5 pounds sterling - no proof required I'm just 
  136.     gonna have to trust you. 
  137.         Please make any cheques payable to D.Odd, and send the dosh to..
  138.  
  139. D. Odd
  140. 68 Gooding Ave.,
  141. Braunstone,
  142. Leicester,
  143. LE3 1BQ,
  144. England.
  145.  
  146. Notes
  147. -----
  148.  
  149.  If you write any modules, have any textures, dithers, upgrades etc., and you
  150. think others may have any use for them, please send them to me. When I get
  151. enough for a disk I'll be able to supply a compilation of them to the
  152. registered users (along with any upgrades/new stuff I write myself). This way
  153. I hope to be able to keep the program going with fresh ideas and more
  154. powerful developments. If everyone who can helps out, there is no reason
  155. why we can't jointly develop a very powerful tool at a fraction of the cost
  156. of certain commercial packages - And a tool which is constantly changing to
  157. meet new fads, demands, file structures, etc.
  158.  
  159.  
  160. INSTRUCTIONS FOR USE
  161. --------------------
  162.  
  163. BASIC STUFF
  164. -----------
  165.  
  166.     Along the top of the window you will see a number of buttons. With
  167. 2,4,8,16 etc. on them. These control how the pictures will be displayed.
  168. These select the amount of colours you want the picture to be rendered in.    
  169.     These range from 2 to 256. Three other modes are available, HAM, 
  170. HAM8 and EHB. HAM and HAM8 allow 4096 or 256,000 colours to appear on screen 
  171. simultaneously, whereas EHB allows 64 colours to be used - although only
  172. half can be defined independently. 
  173.     'But why don't you use the 64 colour button?' I hear you cry. Well
  174. machines before the A1200 (the 12bit_Machines) can only use 2,4,8,16,32,HAM
  175. and EHB modes. So even if you've get an AGA machine you may want any output
  176. produced to work on these earlier machines.
  177.     
  178.     Next are three button, 'Dither', 'HiRes' and 'Lace'. The first 
  179. controls whether or not the program uses dithering routines when it renders
  180. the picture. See the 'Chnge Dither' button for more information. The other
  181. two buttons simply control how the screen is displayed.
  182.  
  183. N.B. On the older machines ('12_Bit') you can only have HiRes in 2,4,8 or 16
  184. colours. 
  185.  
  186. THE MAIN BUTTONS
  187. ----------------
  188.  
  189. Beneath and to the right are the main features, which are listed below...
  190.  
  191. Load - This will load in from disk a new picture, using the default loading
  192.        module (normally IFF - the same file as 'Deluxe Paint' and 'Photon 
  193.        Paint' use). See below for changing the format.
  194.  
  195. Save - This will save to disk the currant picture, using the selected
  196.        routines for displaying and saving.
  197.  
  198. Picture Info - This will tell you about the picture and the currently
  199.                selected options.
  200.  
  201. Chnge Dither - This button allows you to change the way in which (if
  202.                requested) the program will dither a picture. 
  203.                Fundamentally there are two types supported, either mapping
  204.                or Floyd (error distribution). If you select the 'Floyd'
  205.                method NONE of the other options apply. If you choose mapping,
  206.                you have to choose a mapping style (three are supplied) and
  207.                an intensity. This intensity controls how much the mapping
  208.                pattern is applied to the picture, the higher the function
  209.                the more dithering. A value will be suggested for the currant
  210.                amount of colours. This value is ignored if the picture is
  211.                grey-scale.
  212.  
  213. RGB Control - Basic at the moment. Colour images can be separated by a 
  214.           number of different methods one way (and the only way that
  215.           the program supports at the moment) is to split it up into
  216.           red, green and blue components. 
  217.           This function allows you choose each bit and change it
  218.           independently.
  219.  
  220. Palette - Generates the 'best' colours for the currant data. This is NOT
  221.           run separately when you alter the picture. If you change the
  222.       pictures colours (except using the sliders at the bottom of the
  223.           display, or the edit mapping routine) you may need to run this.
  224.  
  225. Display - Displays the picture using the currant display options.
  226.  
  227. Preview - As above but uses faster (and less accurate) routines.
  228.  
  229. Sub Prog - Allows you to run a module or sub-prog which doesn't appear on
  230.            the gadgets. Just select the name of it, and click on RUN.
  231.  
  232. Quit - Quits the program. If you ask for the data to be deleted you will
  233.        have to run INIT before re-loading BlackBoard. However if you don't
  234.        you can simply re-load with all the data still present.
  235.  
  236.  Beneath these system gadgets are 5 sliders. These control the contrast,
  237. brightness, red, green and blue contents of the picture. They don't effect
  238. the picture directly; the displaying routines calculate effects as they draw
  239. it up - and therefore there is no need to re-calculate the palette if they 
  240. are changed (or indeed if the number of colours selected is altered).
  241.  
  242.  To the left are the filters and effect which can be run from the program.
  243. The important ones have a button to themselves, and the rest are present in 
  244. the box. They can be scrolled up and down with the correct buttons, and run
  245. by clicking on the 'RUN' button.
  246.  
  247.  They are all listed below, and what they do. But first... How you enter info
  248. to them.
  249.  
  250. DATA ENTRY
  251. ----------
  252.  
  253.  Each subprog can ask for a number of different types of data. The main 
  254. program will gather these and then pass them on to it. In this way writing 
  255. your own modules is much easier as you don't have to worry about the front
  256. end. 
  257.  Anyway, any information which is requested BY the subprog will be asked for
  258. by a set of buttons which appear in the middle of the screen. These will
  259. be of a number of sorts, all of which should be easy enough to work out
  260. (I hope). 
  261.  
  262.  
  263. THE SYSTEM ROUTINES
  264. -------------------
  265.  
  266.  If you want to change any of the system routines simply go up to the
  267. pull-down menu at the top of the screen and select the one you wish to 
  268. change, and the select the one you want from the choice listed. Each
  269. program does the same thing (e.g. They all calculate the palette, or they
  270. all load an image) but they do it in a different way. (e.g. Different loaders
  271. may load pictures which are saved in different formats)
  272.  
  273. THE SYSTEM MODULES 
  274. ------------------
  275.  
  276. Loaders
  277. -------
  278.  
  279. Load_ILBM - This is the default. Will load in IFF (ILBM) pictures. Up to 
  280.            256 colours, or 8/24 bit files. 
  281.  
  282.  
  283. Load_Sculpt_File - Sculpt files are uncompactable, contain no structure
  284.           (width, height etc.) information and are saved (if in 
  285.                   colour) as three different files. Most filters which
  286.           load in files  will however expect them to be in sculpt
  287.           format.. Why?
  288.                   Because it's easy to read, easy to calculate where
  289.                   specific pixels will be in the files and requires no 
  290.                   computation to convert into 8 or 24 bit files. They 
  291.                   therefore are easy, quick and memory (RAM not disk)
  292.                   efficient.
  293.                Because they have no picture information you must type 
  294.                   in the width of the file and if it is colour (three 
  295.                   files .red, .gre and .blu) or greyscale (just the one).
  296.                    This is done so you can load in say a .red file as a 
  297.                   grey-scale and manipulate it separately.
  298.  
  299.  
  300. Savers
  301. ------
  302.  
  303. Save_ILBM - Saves out currant screen (colours, palette, width etc.) as an
  304.            IFF file, which can be loaded into almost every Amiga art
  305.            package.
  306.  
  307. Save_Sculpt_File - This saves the picture as a sculpt file. Data about the
  308.           picture is NOT saved, and the width is required when you
  309.           reload. So it's best to save the picture as something 
  310.           like "MyPicture(320)" where the '320' is the width. Colour
  311.           images will be saved as 3 files, each one with a suffix.
  312.           i.e. Filename.red, Filename.gre and Filename.blu. 
  313.  
  314. Palette routines
  315. ----------------
  316.  
  317. Palette12 -  This calculates the colours, but only to a resolution of 12
  318.         bits (4096 colours). 
  319.  
  320. Palette18 -  As above but a bit slower. The colours chosen are also
  321.             accurate to 18 bits (265,000 colours).
  322.  
  323. Displayers
  324. ----------
  325.  
  326.  Firstly there are two types of displayers;- grey-scale ones and colour ones.
  327. Only one proper grey-scale one is provided, so you don't have a lot of
  328. choice there - but this does everything anyway so it doesn't matter. Of the
  329. colour ones there are 3 proper ones, and two which is only really of use as
  330. previewers. 
  331.  The HAM and HAM8 routines used by Display12 are different from the others
  332. ONLY in that they use less memory by accessing the data files while drawing
  333. up the picture, they are therefore slightly slower.
  334.  
  335. Routine    Accuracy  Dither      Speed  Other info.
  336. -------------------------------------------------------
  337. Display12   12 bits    Not Floyd  Medium  Low memory needs                                     memory than                                     Display 12 or                                     Display 24
  338. Display15   15 bits    YES        Medium
  339. Display24   24 bits    YES        Slow
  340. HAM routine 24 bits    Not Floyd  Medium  Routine in Display15 used 
  341. HAM8  ""    24 bits    Not Floyd  Slow       Routine in Display15 used
  342. Preview12   12 bits    NO         Fast    Low memory needs
  343. Preview18   18 bits    NO         Fast    Low memory needs
  344. GreyDisplay 24 bits    YES        Fast
  345.  
  346. The previewer's (Preview12/Preview18)  will display all pictures (ignoring
  347. the number of selected colours) in HAM/HAM8,16/256 grey-scale mode using a
  348. fast routine. Very useful throughout the development to see how the
  349. pictures going.
  350.  
  351. USER MODULES
  352. ------------
  353.  
  354. Double_Or_Half - These double or half the picture. They don't just 
  355.             double the pixels, but work on the image to prevent 
  356.                 a 'blocky' look. If you WANT a 'blocky' look use SCALE.
  357.  
  358. Edge_Enhancer - Will either outline of enhance a picture. If you choose
  359.                to enhance the picture then the value entered affects how
  360.                pronounced this enhancement is.  0 will produce the most
  361.            amount of edge enhancement, the bigger the number the 
  362.                less noticeable the effect.
  363.  
  364. Smooth_Filter - Smooths the image. Asks for a threshold value. This will
  365.                only smooth two pixels together if they are closer than this
  366.                value in intensity. Therefore, in the case of a picture of
  367.                a person; it cam be used to smooth the skin, and it will
  368.                smooth the lips, but will not smooth the lips into the 
  369.                skin. It therefore retains sharp lines, but smooths out
  370.                gradients. Very useful for converting old 12 bit images
  371.                into 24 bits. (Value is between 0 (smooth nothing - a bit
  372.                pointless) and 255 (smooth every thing - also pointless
  373.                as `Reduce_Noise` does this faster and better))
  374.  
  375. Reduce_Noise - Provides two routines to 'smooth' and reduce noise in the
  376.               picture. 
  377.  
  378. Emboss_Image - Creates the impression that the image is three dimensional.
  379.  
  380. Composite_Load - This will load in another picture (Sculpt format) and
  381.                 merge it into the picture presently in memory. To do this
  382.                 it needs three pieces of information. Firstly the
  383.                 filename and it's size. Secondly it needs the percent of
  384.                 which to merge (0-100%). If this is 100% the new picture
  385.                 will totally replace the old one; if it's 50% they will
  386.                 mix 50-50.
  387.                  Thirdly it needs a threshold value. This value tells the
  388.                 computer what bits of the image to merge, and what to 
  389.                 make 'see-through'. If the pixels' value is beneath the
  390.                 threshold then the new image is deemed to be 'see-through'
  391.                  e.g. The value can be between 0 and 255. If you enter
  392.                 1 - Everything on the new image will used, except when
  393.                 it's colour is black, then it will be transparent. 
  394.  
  395.                 Finally position the new image on the old one and click on
  396.                 'Load & Mix'.
  397.  
  398. N.B. Colour images can't be mixed with grey-scale pictures and vice-versa.
  399.  
  400. Shade - This also requires a sculpt picture (this time it must be 
  401.        grey-scale); but instead of mixing the file into the present one,
  402.        its used to control the intensity of the present image. 
  403.        If the file loaded contains a pixel of 128 (middle grey), then the
  404.        pixel this maps onto remains the same, if it gets lower, it darkens
  405.        the pixel, and higher it brightens it.
  406.         You don't need to place the image on the page because it will be
  407.        used in a mosaic-like way to effect the entire picture.
  408.        This function can be used for two reasons. Firstly it can be used
  409.        to highlight an area (e.g. Fade the picture to darkness as it 
  410.        reaches the edge of the screen) - or it can be used to 'texture'
  411.        pictures.
  412.         See the example pictures to see how this works.
  413.  
  414. Colour<-->Grey - Converts a 24 bit (colour) image into and 8 bit
  415.                 (grey-scale) image. And vice-versa
  416.  
  417. Crop_Image - This allows you to cut out a segment of a picture and work
  418.             with that. 
  419.  
  420. Scale_Image - Simply change either the actual length or the factors, and
  421.              then click on 'Scale' to change the size of the image.
  422.  
  423. Mapping -  Here you can either set the map, or alter it.
  424.       Setting the map involves permanently altering the picture
  425.           data in so that it's actually stored in the similar way
  426.           to how its displayed (i.e. Brightness, contrast, mapping
  427.       red, green, blue etc.)
  428.           altering the mapping...
  429.            The images are stored as values from 0-255. Where 0=black,
  430.           and 255=max red/green/blue/white.
  431.            You can change this relationship. The graph displayed
  432.       shows the distribution of colours. Fashion the graph 
  433.           anyway you want, and then click at the bottom. 'Default'
  434.           will return your mapping to the simply linear relationship.
  435.        You can also 'bend' the graph up and down by using the 
  436.           appropriate buttons.
  437.  
  438. Edit_Palette - The palette created by the palette selector can here be
  439.               modified. 
  440.  
  441. Rectangle - Allows you to colour in rectangular areas of the picture.
  442.  
  443. Change_Range - The pictures are stored as a block of data, with each red,
  444.           green, blue or grey point being stored as a number between
  445.           0 and 255. This program will show you the min and the max
  446.               values found in all the data and allow you to scale it 
  447.           accordingly.
  448.  
  449.         -----------------------------------
  450. Byeeeeee
  451.  
  452. P.S. If you have any comments, request, advice etc. please feel free to
  453. get in touch with me (see above for my address)
  454. P.P.S. If anyone out their knows anything about the JPEG file format, has 
  455. source code for it utilization or ANYTHING, PLEASE, PLEASE, PLEASE get in 
  456. touch.
  457.  
  458.  
  459.